Skip to main content

API Keys Creation Tutorial

How to create a key:​

Prerequisites:

  1. In your Corva account go to Control Center -> API Keys.
  2. Press the NEW API KEY button.

api_key

  1. There are different settings and options you can use:
  • Key Name: the value is generated automatically. However, you change it to any unique value to identify the key. There are no syntax restrictions;
  • Company: choose the company with which the API key will be associated;
  • Permissions: set up the required permission type;
  • Owner Type: this value identificates the entity which the API key is going to work with. For example, the Dataset Owner Type, creates the key to work with datasets only;
  • Owner: the user associated with the API key. The permissions of the user scoups the API key access;
  • Requested by: the user who requests the key;
  • Approved by: the user who approves the key;
  1. Once the API key is created, you can copy it to your clipboard.

created_key

  1. After the key is created, you also can:
  • Copy - extract the API key value you can use in your API requests;
  • Edit - change the settings of the API key
  • Terminate - delete the API key

api_edit

Notes:​

  1. There are different permission options:
  • Read: Read only permissions to the data of the user's company;
  • ReadWrite: Read/Write permissions to the data of the user's company;
  • Admin: Read/Write permissions to several companies data for Corva admins;
  1. The Owner type field is optional. The user and the company options are used by default. Also, the Owner is subparameter of the Owner type field. These fields don't affect the key's functionality for now.